Get Accounts

GET /api/v1/accounts

Description

Retrieve a list of accounts based on various query parameters.

Path Parameters

Name	Type	Description
None		No parameters

Query Parameters

Name	Type	Description
accountByAccountNumbers	string	Account numbers separated by commas (e.g., 12345,67890)
accountByAccountIds	string	Account IDs separated by commas (e.g., acc1,acc2)
accountCreatedRange	string	Date range for account creation (e.g., 2024-01-03,2024-06-04)
accountTenantIds	string	Tenant IDs separated by commas (e.g., tenant1,tenant2)
accountType	string	Available values: USER, BUSINESS, TENANT
accountDisplayType	string	Default is LIST. Available values: LIST, PAGING
search	string	Search query
order	string	Available values: ASC, DESC
page	string	Page number
limit	string	Number of records per page

Example

GET /api/v1/accounts?accountByAccountNumbers=12345,67890&accountByAccountIds=acc1,acc2&accountCreatedRange=2024-01-03,2024-06-04&accountTenantIds=tenant1,tenant2&accountType=USER&accountDisplayType=LIST&search=query&order=ASC&page=1&limit=10

Response Code: 200 - OK

Description

List of accounts retrieved successfully.

Response Fields

Field	Type	Description
status	boolean	Indicates if the operation was successful
statusCode	integer	Status code
message	string	Response message
data	object	Data related to the accounts
errors	array	List of error messages, if any

Example

{
  "status": true,
  "statusCode": 0,
  "message": "Accounts retrieved successfully",
  "data": [
    {
      "accountId": "acc1",
      "accountNumber": "12345",
      "accountType": "USER",
      "accountCreatedDate": "2024-01-03",
      "tenantId": "tenant1"
    },
    {
      "accountId": "acc2",
      "accountNumber": "67890",
      "accountType": "BUSINESS",
      "accountCreatedDate": "2024-02-14",
      "tenantId": "tenant2"
    }
  ],
  "errors": []
}

Headers

Content-Type	Value
apiKey	{{apiKey}}
userid	string

🔑 Authentication bearer

Param	Value	Type
token	{{accessCode}}	string